/*
 *  Copyright (C) 2010 glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.application;

import org.balisunrise.common.VisualEntity;
import org.balisunrise.common.Visualizable;

/**
 * Window: Interface que contém e exibe um VisualEntity.
 * A Window pode ter ações para Confirmar e Cancelar. Ao confirmar ou cancelar
 * a Window pode fechar e retornar execução.
 * Caso o VisualEntity possuir um EntityAction, a Window pode criar as ações de
 * Confirmar e Cancelar e atribuir ao EntityAction.
 * A Window extende Visualizable e sue owner é a Application.
 * As Window são criadas e exibidas atravéz do WindowsManager.
 * <br><i>
 * Por exemplo, se for utilizado a API do swing para implementação
 * das representações visuais das entidades, a representação visual de um Window
 * pode ser JDialog, JFrame, JWindow. No caso de Utilizar o NetBeans Plataform
 * a Window pode ser um TopComponent.</i>
 *
 * @author Glauco
 */
public interface Window<V> extends Visualizable<V> {

    /**
     * Retorna a VisualEntity desta Window.
     * @return
     */
    public VisualEntity getVisualEntity();

    /**
     * Algumas Window podem retornar ao confirmar ou cancelar, se for uma destas
     * é retornado um objeto Boolean informando se foi confirmado.
     * Quando as Window não retornam ao confirmar, é retornado nulo.
     *
     * @return <code>true</code> se foi confirmada a Window, <code>false</code>
     * caso contrário e <code>null</code> caso a confirmação da Window não
     * termina a exibição.
     */
    public Boolean getConfirmation();

    /**
     * Exibe a Window.
     * @param visible se é para exibir a Window.
     */
    public void setVisible(boolean visible);
}
